Move documentation from templates to inline comments: GtkAccelGroup

https://bugzilla.gnome.org/show_bug.cgi?id=597865

diff --git a/docs/reference/gtk/tmpl/gtkaccelgroup.sgml b/docs/reference/gtk/tmpl/gtkaccelgroup.sgml
deleted file mode 100644 (file)
index c6170c5..0000000
--- a/docs/reference/gtk/tmpl/gtkaccelgroup.sgml
+++ /dev/null
@@ -1,327 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Accelerator Groups
-
-<!-- ##### SECTION Short_Description ##### -->
-Groups of global keyboard accelerators for an entire GtkWindow
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A #GtkAccelGroup represents a group of keyboard accelerators,
-typically attached to a toplevel #GtkWindow (with
-gtk_window_add_accel_group()). Usually you won't need to create a
-#GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+
-automatically sets up the accelerators for your menus in the item
-factory's #GtkAccelGroup.
-</para>
-
-<para>
-Note that <firstterm>accelerators</firstterm> are different from
-<firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
-activating a menu item; they appear alongside the menu item they're a
-shortcut for. For example "Ctrl+Q" might appear alongside the "Quit"
-menu item. Mnemonics are shortcuts for GUI elements such as text
-entries or buttons; they appear as underlined characters. See
-gtk_label_new_with_mnemonic(). Menu items can have both accelerators
-and mnemonics, of course.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-gtk_window_add_accel_group(), gtk_accel_map_change_entry(),
-gtk_item_factory_new(), gtk_label_new_with_mnemonic()
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkAccelGroup ##### -->
-<para>
-An object representing and maintaining a group of accelerators.
-</para>
-
-
-<!-- ##### SIGNAL GtkAccelGroup::accel-activate ##### -->
-<para>
-
-</para>
-
-@accelgroup: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
-@Returns: 
-
-<!-- ##### SIGNAL GtkAccelGroup::accel-changed ##### -->
-<para>
-
-</para>
-
-@accelgroup: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
-
-<!-- ##### ARG GtkAccelGroup:is-locked ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkAccelGroup:modifier-mask ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_accel_group_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO gtk_accel_group_ref ##### -->
-<para>
-Deprecated equivalent of g_object_ref().
-</para>
-
-@Returns: the accel group that was passed in
-
-
-<!-- ##### MACRO gtk_accel_group_unref ##### -->
-<para>
-Deprecated equivalent of g_object_unref().
-</para>
-
-
-
-<!-- ##### FUNCTION gtk_accel_group_connect ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@accel_key: 
-@accel_mods: 
-@accel_flags: 
-@closure: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_connect_by_path ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@accel_path: 
-@closure: 
-
-
-<!-- ##### USER_FUNCTION GtkAccelGroupActivate ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@acceleratable: 
-@keyval: 
-@modifier: 
-@Returns: 
-
-
-<!-- ##### USER_FUNCTION GtkAccelGroupFindFunc ##### -->
-<para>
-
-</para>
-
-@key: 
-@closure: 
-@data: 
-@Returns: 
-@Since: 2.2
-
-
-<!-- ##### FUNCTION gtk_accel_group_disconnect ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@closure: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_disconnect_key ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@accel_key: 
-@accel_mods: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_query ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@accel_key: 
-@accel_mods: 
-@n_entries: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_activate ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@accel_quark: 
-@acceleratable: 
-@accel_key: 
-@accel_mods: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_lock ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_unlock ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_get_is_locked ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_from_accel_closure ##### -->
-<para>
-
-</para>
-
-@closure: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_get_modifier_mask ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_groups_activate ##### -->
-<para>
-
-</para>
-
-@object: 
-@accel_key: 
-@accel_mods: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_groups_from_object ##### -->
-<para>
-
-</para>
-
-@object: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accel_group_find ##### -->
-<para>
-
-</para>
-
-@accel_group: 
-@find_func: 
-@data: 
-@Returns: 
-
-
-<!-- ##### STRUCT GtkAccelKey ##### -->
-<para>
-
-</para>
-
-@accel_key: 
-@accel_mods: 
-@accel_flags: 
-
-<!-- ##### FUNCTION gtk_accelerator_valid ##### -->
-<para>
-
-</para>
-
-@keyval: 
-@modifiers: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accelerator_parse ##### -->
-<para>
-
-</para>
-
-@accelerator: 
-@accelerator_key: 
-@accelerator_mods: 
-
-
-<!-- ##### FUNCTION gtk_accelerator_name ##### -->
-<para>
-
-</para>
-
-@accelerator_key: 
-@accelerator_mods: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accelerator_get_label ##### -->
-<para>
-
-</para>
-
-@accelerator_key: 
-@accelerator_mods: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_accelerator_set_default_mod_mask ##### -->
-<para>
-
-</para>
-
-@default_mod_mask: 
-
-
-<!-- ##### FUNCTION gtk_accelerator_get_default_mod_mask ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-

diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index b26fd63a0501b88677f94649b86f209c49127f81..03ade12668c1418abe083a6859648bb818defb11 100644 (file)
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -37,6 +37,31 @@
 #include "gtkmarshalers.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkaccelgroup
+ * @Short_description: Groups of global keyboard accelerators for an entire GtkWindow
+ * @Title: Accelerator Groups
+ * @See_also:gtk_window_add_accel_group(), gtk_accel_map_change_entry(),
+ * gtk_item_factory_new(), gtk_label_new_with_mnemonic()
+ * 
+ * A #GtkAccelGroup represents a group of keyboard accelerators,
+ * typically attached to a toplevel #GtkWindow (with
+ * gtk_window_add_accel_group()). Usually you won't need to create a
+ * #GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+
+ * automatically sets up the accelerators for your menus in the item
+ * factory's #GtkAccelGroup.
+ * 
+ * 
+ * Note that <firstterm>accelerators</firstterm> are different from
+ * <firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
+ * activating a menu item; they appear alongside the menu item they're a
+ * shortcut for. For example "Ctrl+Q" might appear alongside the "Quit"
+ * menu item. Mnemonics are shortcuts for GUI elements such as text
+ * entries or buttons; they appear as underlined characters. See
+ * gtk_label_new_with_mnemonic(). Menu items can have both accelerators
+ * and mnemonics, of course.
+ */
+
 
 /* --- prototypes --- */
 static void gtk_accel_group_finalize     (GObject    *object);

diff --git a/gtk/gtkaccelgroup.h b/gtk/gtkaccelgroup.h
index 80780dba5a152a8a8a4e4ebb2a48c067a834c00c..b1e874491ed948677de861ff6f05f9e435081e3c 100644 (file)
--- a/gtk/gtkaccelgroup.h
+++ b/gtk/gtkaccelgroup.h
@@ -66,10 +66,23 @@ typedef gboolean (*GtkAccelGroupActivate) (GtkAccelGroup  *accel_group,
                                           guint           keyval,
                                           GdkModifierType modifier);
 
+/**
+ * GtkAccelGroupFindFunc:
+ * @key: 
+ * @closure: 
+ * @data: 
+ * 
+ * Since: 2.2
+ */
 typedef gboolean (*GtkAccelGroupFindFunc) (GtkAccelKey    *key,
                                           GClosure       *closure,
                                           gpointer        data);
 
+/**
+ * GtkAccelGroup:
+ * 
+ * An object representing and maintaining a group of accelerators.
+ */
 struct _GtkAccelGroup
 {
   GObject             parent;
@@ -180,7 +193,20 @@ struct _GtkAccelGroupEntry
 
 
 #ifndef GTK_DISABLE_DEPRECATED
+/**
+ * gtk_accel_group_ref:
+ * 
+ * Deprecated equivalent of g_object_ref().
+ * 
+ * Returns: the accel group that was passed in
+ */
 #define        gtk_accel_group_ref     g_object_ref
+
+/**
+ * gtk_accel_group_unref:
+ * 
+ * Deprecated equivalent of g_object_unref().
+ */
 #define        gtk_accel_group_unref   g_object_unref
 #endif /* GTK_DISABLE_DEPRECATED */